组织(Organization)

[GET] /api/v2/identity/organizations

获取所有组织信息

参数

名称	类型	位于	描述
includeProps	Boolean	query	是否需要获取属性信息. 传参示例: false

响应

状态代码: 200

成功

TenantBizModel

[POST] /api/v2/identity/organizations

增加一个新组织

请求格式

TenantCreateModel

响应

状态代码: 201

成功

TenantBizModel

状态代码: 400

请求错误

ApiErrorResult

状态代码: 403

被禁用

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}

获取特定的某个组织信息

参数

名称	类型	位于	描述
id必填项	string	path	组织Id

响应

状态代码: 200

成功

TenantBizModel

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/organizations/{id}

修改指定的组织信息

参数

名称	类型	位于	描述
id必填项	string	path	组织Id

请求格式

TenantUpdateModel

响应

状态代码: 200

成功

TenantBizModel

状态代码: 400

请求错误

ApiErrorResult

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/organizations/{id}

删除某个指定的组织

参数

名称	类型	位于	描述
id必填项	string	path	组织Id

响应

状态代码: 204

成功

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/sub-organizations

获取指定组织的所有子组织

参数

名称	类型	位于	描述
id必填项	string	path	组织Id
includeSelf	Boolean	query	是否需要包含指定的组织自己本身. 例如: false

响应

状态代码: 200

成功

TenantBizModel

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/ancestor-organizations

获取指定组织的所有祖先(父节点)组织

参数

名称	类型	位于	描述
id必填项	string	path	组织Id

响应

状态代码: 200

成功

TenantBizModel

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/users

获取某个组织下的用户

参数

名称	类型	位于	描述
id必填项	string	path	组织Id
includeSubOrganizationUsers	Boolean	query	是否包含子组织用户，例如: false

响应

状态代码: 200

成功

UserBizModel

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/organizations/{id}/users

给指定的组织增加用户

参数

名称	类型	位于	描述
id必填项	string	path	组织Id

请求格式

UserListModel

响应

状态代码: 200

成功

UserBizModel

状态代码: 400

请求错误

ApiErrorResult

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/organizations/{id}/users

修改指定组织下的用户信息

参数

名称	类型	位于	描述
id必填项	string	path	组织Id

请求格式

UserListModel

响应

状态代码: 200

成功

UserBizModel

状态代码: 400

请求错误

ApiErrorResult

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/organizations/{id}/users/{userId}

删除指定组织下的指定用户

参数

名称	类型	位于	描述
id必填项	string	path	组织Id
userId必填项	string	path	用户Id

响应

状态代码: 204

成功

状态代码: 400

请求错误

ApiErrorResult

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/non-org-users

获取不属于该组织的用户列表

参数

名称	类型	位置
id必填项	string	path

响应

状态代码: 200

成功

UserBizModel

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/roles

获取某个组织下的所有角色

参数

名称	类型	位于	描述
id必填项	string	path	组织Id
includeSubOrgRoles	Boolean	query	是否返回所有子部门的角色 例如: false

响应

状态代码: 200

成功

RoleBizModel

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/organizations/{id}/roles

给某个组织增加新角色

参数

名称	类型	位于	描述
id必填项	string	path	组织Id

请求格式

name

响应

状态代码: 201

成功

RoleBizModel

状态代码: 400

请求错误

ApiErrorResult

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/roles/{roleId}

获取指定组织的角色

参数

名称	类型	位于	描述
id必填项	string	path	组织Id
roleId必填项	string	path	角色Id

响应

状态代码: 200

成功

RoleBizModel

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/organizations/{id}/roles/{roleId}

删除某个组织下的某个角色

参数

名称	类型	位于	描述
id必填项	string	path	组织Id
roleId必填项	string	path	角色Id

响应

状态代码: 204

成功

状态代码: 400

请求错误

ApiErrorResult

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/roles/{roleId}/users

获取某个组织与角色下的用户

参数

名称	类型	位于	描述
id必填项	string	path	组织Id
roleId必填项	string	path	角色Id

响应

状态代码: 200

成功

UserBizModel

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/organizations/{id}/roles/{roleId}/users

给指定的组织与角色增加用户

参数

名称	类型	位于	描述
id必填项	string	path	组织Id
roleId必填项	string	path	角色Id

请求格式

UserListModel

响应

状态代码: 200

成功

UserBizModel

状态代码: 400

请求错误

ApiErrorResult

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/organizations/{id}/roles/{roleId}/users

更新某个组织与角色下的用户信息

参数

名称	类型	位于	描述
id必填项	string	path	组织Id
roleId必填项	string	path	角色Id

请求格式

UserListModel

响应

状态代码: 200

成功

UserBizModel

状态代码: 400

请求错误

ApiErrorResult

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/organizations/{id}/roles/{roleId}/users/{userId}

删除指定组织和角色下的某个用户

参数

名称	类型	位于	描述
id必填项	string	path	组织Id
roleId必填项	string	path	角色Id
userId必填项	string	path	用户Id

响应

状态代码: 204

成功

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/roles/{roleId}/permissions

获取指定组织与角色的权限

参数

名称	类型	位于	描述
id必填项	string	path	组织Id
roleId必填项	string	path	角色Id

响应

状态代码: 200

成功

PermissionModel

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/organizations/{id}/roles/{roleId}/permissions

更新指定的组织与角色的权限

参数

名称	类型	位于	描述
id必填项	string	path	组织Id
roleId必填项	string	path	角色Id

请求格式

PermissionListModel

响应

状态代码: 200

成功

PermissionModel

状态代码: 400

请求错误

ApiErrorResult

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/{id}/permissions

获取指定组织的权限

参数

名称	类型	位于	描述
id必填项	string	path	组织Id

响应

状态代码: 200

成功

PermissionModel

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/organizations/{id}/permissions

更新指定组织的权限

参数

名称	类型	位于	描述
id必填项	string	path	组织Id

请求格式

PermissionListModel

响应

状态代码: 200

成功

PermissionModel

状态代码: 400

请求错误

ApiErrorResult

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/organizations/props

获取所有组织的属性

参数

名称	类型	位置
includeBuiltInProps	Boolean	query

响应

状态代码: 200

成功

TenantPropModel

[POST] /api/v2/identity/organizations/props

增加一个新的组织属性

请求格式

TenantPropInfoModel

响应

状态代码: 201

成功

TenantPropModel

状态代码: 400

请求错误

ApiErrorResult

[GET] /api/v2/identity/organizations/props/{propId}

获取指定的组织属性信息

参数

名称	类型	位于	描述
propId必填项	string	path	组织属性Id

响应

状态代码: 200

成功

TenantPropModel

状态代码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/organizations/props/{propId}

修改指定的组织属性

参数

名称	类型	位于	描述
propId必填项	string	path	组织属性Id

请求格式

TenantPropInfoModel

响应

状态代码: 200

成功

TenantPropModel

状态代码: 400

请求错误

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/organizations/props/{propId}

删除指定的组织属性

参数

名称	类型	位于	描述
propId必填项	string	path	组织属性Id

响应

状态代码: 204

成功

状态代码: 400

请求错误

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/organizations/{id}/move

修改指定的组织顺序

参数

名称	类型	位于	描述
id必填项	string	path	组织Id

请求格式

int32

响应

状态代码: 204

成功

状态代码: 403

已禁止

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/organizations/{id}/migrate

迁移指定的组织

参数

名称	类型	位于	描述
id必填项	string	path	组织Id

请求格式

OrganizationMigrationModel

响应

状态代码: 204

成功

状态代码: 400

请求错误

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

模型定义

Ƭ TenantBizModel

名称	类型	描述	示例
id可为空	string
name可为空	string
description可为空	string
enabled	Boolean
path可为空	string
parentTenantId可为空	string
order	int32
createTime	ISO DateTime Sting
props可为空	TenantPropValueBizModel

Ƭ TenantPropValueBizModel

名称	类型	描述	示例
id可为空	string	组织属性的唯一标识符	"393B6B48-4C8B-4B0F-9175-A01177CBD328"
allowSubTenantEditing	Boolean	是否允许子部门编辑这个数值	true
editable	Boolean	该数值是否可编辑	true
allowSubTenantViewing	Boolean	是否允许子部门查看这个数值	true
viewable	Boolean	该属性是否可见	true
values可为空	Array<string>	属性值	["value1","value2","value3"]
name	string	组织属性名称	"OrganizationAddress"
description可为空	string	组织属性描述文本	"The address of the organization."
required	Boolean	该属性是否必填	true
valueType	TenantPropValueType
multivalued	Boolean	该属性是否为多值	true

Ƭ TenantPropValueType

Enum:

• Text
• Boolean
• Number
• Password

组织属性的值类型

* Text - 0 - 普通字符串
* Boolean - 1 - 布尔类型
* Number - 2 - 数值类型
* Password - 3 - 密码字符类型

Ƭ ApiErrorResult

该模型用于描述所有出现的异常

名称	类型	描述	示例
errors可为空	ApiError	错误列表

Ƭ ApiError

当处理网络请求错误时，使用该模型来描述错误信息

名称	类型	描述	示例
code可为空	string	错误的唯一编号
message可为空	string	错误的描述信息
context可为空	string	与错误有关的上下文信息

Ƭ TenantCreateModel

名称	类型	描述	示例
parentTenantId可为空	string	父复制的Id,为空(null)就会将组织创建到"全局"下	"3FEF2BB9-4D25-47AA-8196-928CEC86A7C6"
name可为空	string	组织名称	"GrapeCity"
description可为空	string	组织的描述信息	"This is a sample organization."
props可为空	TenantPropValueBizModel	组织的属性

Ƭ TenantUpdateModel

名称	类型	描述	示例
name可为空	string	组织名称	"GrapeCity"
description可为空	string	组织的描述信息	"This is a sample organization."
props可为空	TenantPropValueBizModel	组织的属性

Ƭ UserBizModel

名称	类型	描述	示例
id可为空	string
username可为空	string
email可为空	string
mobile可为空	string
provider可为空	string
avatar可为空	string
firstName可为空	string
lastName可为空	string
creationTime	ISO DateTime Sting
status	UserStatus
fullName可为空	string
organizationIdPath可为空	string
roles可为空	Array<string>
customizeProperties可为空	Array<string>
extraClaims可为空	string
tenantRoles可为空	Array<string>

Ƭ UserStatus

枚举:

• Normal
• Disabled

用户的状态

* Normal - 1 - 正常状态
* Disabled - 2 - 禁用状态

Ƭ UserListModel

名称	类型	描述	示例
userIds	Array<string>	用户Id列表	["5A0E8745-A515-42E3-B225-F7DDE06B5632","9B987F4B-894C-48CC-836F-D67522B0A680"]

Ƭ RoleBizModel

名称	类型	描述	示例
id可为空	string	角色的唯一Id	"972B2A4C-8C61-4E3B-AD3D-6E889FE8D761"
name可为空	string	角色名称	"DataManager"
creatorId可为空	string	角色的创建者Id	"CF61388C-D7CD-4A61-8FB3-A8A0B6915F3E"
createTime	ISO DateTime Sting	创建时间	"2000-01-01 00:00:00.000"
isBuiltin	Boolean	是否是内置角色
allowEditPermissions	Boolean	是否允许角色的编辑权限	true
permissions可为空	Array<string>	角色的权限	["view-report","view-dashboard"]
members可为空	Array<string>	角色成员的Id列表	["CD079B35-4A56-4F42-845D-726B09E08EA9","EAAA677A-7B0A-4471-99F0-4C3F1D31738C"]
tenantId可为空	string	角色所属的组织Id	"D6FD678D-45B5-4222-BA81-58BE2E578F91"

Ƭ PermissionModel

名称	类型	描述	示例
name可为空	string
description可为空	string
enabled	Boolean
order	int32
module可为空	string
category可为空	string
isCustomPermission	Boolean

Ƭ PermissionListModel

名称	类型	描述	示例
permissions	Array<string>	权限列表	["view-dashboard","view-report"]

Ƭ TenantPropModel

名称	类型	描述	示例
id可为空	string
name	string
description可为空	string
required	Boolean
valueType	TenantPropValueType
multivalued	Boolean
tenantpropRestrictions可为空	TenantPropRestrictionModel
tenantPropValues可为空	TenantPropValueModel

Ƭ TenantPropRestrictionModel

名称	类型	描述	示例
tenantId	string
tenantPropId	string
allowSubTenantEditing	Boolean
allowSubTenantViewing	Boolean
tenant	TenantModel
tenantProp	TenantPropModel

Ƭ TenantPropValueModel

名称	类型	描述	示例
id可为空	string
tenantId	string
tenantPropId	string
value可为空	string
tenant	TenantModel
tenantProp	TenantPropModel

Ƭ TenantModel

名称	类型	描述	示例
id可为空	string
name	string
description可为空	string
enabled	Boolean
parentTenantId可为空	string
path可为空	string
order	int32
createTime	ISO DateTime Sting
parentTenant	TenantModel
tenantPropValues可为空	TenantPropValueModel
userTenants可为空	UserTenantModel
tenantRoles可为空	RoleModel
tenantSettings可为空	TenantSettingModel
tenantPropRestrictions可为空	TenantPropRestrictionModel

Ƭ UserTenantModel

名称	类型	描述	示例
userId	string
tenantId	string
user	UserModel
tenant	TenantModel

Ƭ RoleModel

名称	类型	描述	示例
id可为空	string
name可为空	string
creatorId可为空	string
createTime	ISO DateTime Sting
isBuiltin	Boolean
allowEditPermissions	Boolean
tenantId可为空	string
creator	UserModel
userRoles可为空	UserRoleModel
permissions可为空	RolePermissionModel
tenant	TenantModel

Ƭ TenantSettingModel

名称	类型	描述	示例
id可为空	string
tenantId可为空	string
pluginKey可为空	string
settingsGroupKey可为空	string
settings可为空	string
tenant	TenantModel
settingsText可为空	string

Ƭ UserModel

名称	类型	描述	示例
id可为空	string
username可为空	string
passwordHash可为空	string
email可为空	string
mobile可为空	string
providerId可为空	string
avatar可为空	string
firstName可为空	string
lastName可为空	string
creationTime	ISO DateTime Sting
enabled	Boolean
fullName可为空	string
organizationIdPath可为空	string
userRoles可为空	UserRoleModel
userGroups可为空	UserGroupModel
userProperties可为空	UserPropertyModel
extraClaims可为空	UserClaimModel
userTenants可为空	UserTenantModel
userAvatar	UserAvatarModel

Ƭ UserRoleModel

名称	类型	描述	示例
userId可为空	string
roleId可为空	string
user	UserModel
role	RoleModel

Ƭ UserGroupModel

名称	类型	描述	示例
groupId可为空	string
userId可为空	string
group	GroupModel
user	UserModel

Ƭ UserPropertyModel

名称	类型	描述	示例
id可为空	string
userId	string
propertyId	string
propertyValue可为空	string
user	UserModel
property	CustomizePropertyModel

Ƭ UserClaimModel

名称	类型	描述	示例
name可为空	string
value可为空	string
userId可为空	string
user	UserModel

Ƭ UserAvatarModel

名称	类型	描述	示例
userId可为空	string
image可为空	string
lastModified	ISO DateTime Sting
user	UserModel

Ƭ RolePermissionModel

名称	类型	描述	示例
roleId可为空	string
permissionName可为空	string
role	RoleModel

Ƭ GroupModel

名称	类型	描述	示例
id可为空	string
name可为空	string
creatorId可为空	string
creationTime	ISO DateTime Sting
parentGroupId可为空	string
path可为空	string
parentGroup	GroupModel
creator	UserModel
userGroups可为空	UserGroupModel

Ƭ CustomizePropertyModel

名称	类型	描述	示例
id可为空	string
name可为空	string
showInList	Boolean
allowUserEdit	Boolean
multivalued	Boolean
showInProfile	Boolean
availableValues可为空	CustomizePropertyAvailableValueModel
userProperties可为空	UserPropertyModel

Ƭ CustomizePropertyAvailableValueModel

名称	类型	描述	示例
customizePropertyId可为空	string
value可为空	string
customizeProperty	CustomizePropertyModel

Ƭ TenantPropInfoModel

名称	类型	描述	示例
name	string	组织属性名称	"OrganizationAddress"
description可为空	string	组织属性的描述信息	"The address of the organization."
required	Boolean	是否为必须项	true
valueType	TenantPropValueType
multivalued	Boolean	属性是否为多值	true

Ƭ OrganizationMigrationModel

名称	类型	描述	示例
parentOrgId可为空	string	目标的父组织Id	"EC6AC4F7-B689-4673-A6B5-C9FE6C979D47"
order	int32	组织的顺序	1